Skip to main content
Feedback

Get Deployed Universe

Basic authentication

The Get Deployed Universe operation retrieves the XML representation of a specified universe (domain and model configuration) under the authenticated account.

To perform this operation using Basic auth, send an HTTP GET request to:

https://<base URL>/mdm/universes/<universeID>

where base URL is the URL for your Hub cloud that hosts your repository.

JWT authentication

To perform this operation using JSON Web Token (JWT) authentication, send an HTTP GET request to:

https://<base URL>/mdm/universes/<universeID>?repositoryId=<repository ID>

You must have the following MDM privileges:

  • MDM - View Repositories
  • MDM - View Models
note

You can implement requests for this operation in processes using the HTTP Client connector, as demonstrated by example 2 in the sample process Hub: Get Deployed Universe Information, which you can install in your account from the process library in Integration.

Query parameters

repositoryId
ID of the repository. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.

Path parameters

universeID
ID of the universe

Responses

  • 200 (OK) Sample response body:

       <universe>
          <id>1d969a54-49e5-4f75-974a-85869280873d</id>
          <version>836e6d2d-47c7-457b-94f1-54ae07492d2f</version>
          <name>employees</name>
          <stats asOf="2015-08-10T15:58:09.034Z" quarantinedRecords="1" enddatedRecords="0" activeRecords="0">
             <sourceStats undeliverableChannelDeliveries="0" pendingChannelDeliveries="0" pendingBatchRecords="0" pendingBatchUpdates="0" sourceCode="s2"/>
             <sourceStats undeliverableChannelDeliveries="0" pendingChannelDeliveries="0" pendingBatchRecords="0" pendingBatchUpdates="0" sourceCode="s1"/>
          </stats>
          <sources>
             <source code="s2" componentId="21e69e35-77a2-4db7-95fb-7214f30138a9"  
                   state="STRAPPED" allowContribute="true">
                <channel primary="true" state="STRAPPED" updateType="DIFF" id="dc875c5c-a83d-42b5-a01a-294613bca68a"/>
             </source>
             <source code="s1" componentId="9d443e21-ec56-4012-818f-9011be640b40"  
                   state="STRAPPED" allowContribute="true" default="true">
                <channel primary="true" state="STRAPPED" updateType="FULL" id="a8ecff8f-071c-43b2-a689-ef9c5fc758da"/>
             </source>
          </sources>
          <layoutid>1d969a54-49e5-4f75-974a-85869280873d</layoutid>
          <layout idXPath="/employees/id">
             <model name="employees">
                <element repeatable="false" titleField="false" enforceIntegrity="false" required="false" type="STRING" prettyName="name" name="name" uniqueId="UQKEY"/>
                <element collectionUniqueId="PHONE_1" collectionTag="phone" collectionPrettyName="phone" collectionMatchType="OCCURRENCE" repeatable="true" titleField="false" enforceIntegrity="false" required="false" type="STRING" prettyName="phone" name="phone" uniqueId="PHONE"/>
                <element collectionUniqueId="EMAIL_1" collectionTag="email" collectionPrettyName="email" collectionMatchKeys="TYPE" collectionMatchType="KEY" repeatable="true" titleField="false" enforceIntegrity="false" required="false" type="CONTAINER" prettyName="email" name="email" uniqueId="EMAIL">
                   <element repeatable="false" titleField="false" enforceIntegrity="false" required="false" type="STRING" prettyName="type" name="type" uniqueId="TYPE"/>
                   <element repeatable="false" titleField="false" enforceIntegrity="false" required="false" type="STRING" prettyName="email" name="email" uniqueId="EMAIL_2"/>
                </element>
                <element collectionUniqueId="ADDR" collectionTag="addr" collectionPrettyName="addr" collectionMatchKeys="TYPE_1" collectionMatchType="KEY" repeatable="true" titleField="false" enforceIntegrity="false" required="false" type="CONTAINER" prettyName="addrs" name="addrs" uniqueId="ADDRS">
                   <element repeatable="false" titleField="false" enforceIntegrity="false" required="true" type="ENUMERATION" prettyName="type" name="type" uniqueId="TYPE_1">
                      <value>home</value>
                      <value>work</value>
                      <value>away</value>
                      <value>unknown</value>
                   </element>
                   <element repeatable="false" titleField="false" enforceIntegrity="false" required="false" type="CONTAINER" prettyName="address" name="address" uniqueId="ADDRESS">
                      <element repeatable="false" titleField="false" enforceIntegrity="false" required="false" type="STRING" prettyName="line" name="line" uniqueId="LINE"/>
                      <element repeatable="false" titleField="false" enforceIntegrity="false" required="false" type="STRING" prettyName="zip" name="zip" uniqueId="ZIP"/>
                   </element>
                </element>
             </model>
             <deletedElements/>
             <xsd><![CDATA[<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name="employees"><xs:complexType><xs:all><xs:element maxOccurs="1" minOccurs="1" name="id" type="xs:string"/><xs:element maxOccurs="1" minOccurs="0" name="name" type="xs:string"/><xs:element maxOccurs="1" minOccurs="0" name="phone"><xs:complexType><xs:sequence><xs:element maxOccurs="unbounded" minOccurs="0" name="phone" type="xs:string"/></xs:sequence></xs:complexType></xs:element><xs:element maxOccurs="1" minOccurs="0" name="email"><xs:complexType><xs:sequence><xs:element maxOccurs="unbounded" minOccurs="0" name="email"><xs:complexType><xs:all><xs:element maxOccurs="1" minOccurs="0" name="type" type="xs:string"/><xs:element maxOccurs="1" minOccurs="0" name="email" type="xs:string"/></xs:all></xs:complexType></xs:element></xs:sequence></xs:complexType></xs:element><xs:element maxOccurs="1" minOccurs="0" name="addr"><xs:complexType><xs:sequence><xs:element maxOccurs="unbounded" minOccurs="0" name="addrs"><xs:complexType><xs:all><xs:element maxOccurs="1" minOccurs="0" name="type" type="xs:string"/><xs:element maxOccurs="1" minOccurs="0" name="address"><xs:complexType><xs:all><xs:element maxOccurs="1" minOccurs="0" name="line" type="xs:string"/><xs:element maxOccurs="1" minOccurs="0" name="zip" type="xs:string"/></xs:all></xs:complexType></xs:element></xs:all></xs:complexType></xs:element></xs:sequence></xs:complexType></xs:element></xs:all><xs:attribute name="op" type="xs:string"/><xs:attribute name="ts" type="xs:string"/><xs:attribute name="grid" type="xs:string"/><xs:attribute name="enddate" type="xs:string"/></xs:complexType></xs:element></xs:schema>]]></xsd>
             <field prettyName="Id" type="STRING" xpath="/employees/id"/>
             <field titleField="false" enforceIntegrity="false" required="false" prettyName="name" type="STRING" xpath="/employees/name" uniqueId="UQKEY"/>
             <field collectionMatchType="OCCURRENCE" prettyName="phone" type="COLLECTION" xpath="/employees/phone" uniqueId="PHONE_1"/>
             <field collectionId="PHONE_1" titleField="false" enforceIntegrity="false" required="false" prettyName="phone" type="STRING" xpath="/employees/phone/phone" uniqueId="PHONE"/>
             <field collectionMatchType="KEY" prettyName="email" type="COLLECTION" xpath="/employees/email" uniqueId="EMAIL_1">
                <matchKey>TYPE</matchKey>
             </field>
             <field collectionId="EMAIL_1" titleField="false" enforceIntegrity="false" required="false" prettyName="type" type="STRING" xpath="/employees/email/email/type" uniqueId="TYPE"/>
             <field collectionId="EMAIL_1" titleField="false" enforceIntegrity="false" required="false" prettyName="email" type="STRING" xpath="/employees/email/email/email" uniqueId="EMAIL_2"/>
             <field collectionMatchType="KEY" prettyName="addr" type="COLLECTION" xpath="/employees/addr" uniqueId="ADDR">
                <matchKey>TYPE_1</matchKey>
             </field>
             <field collectionId="ADDR" titleField="false" enforceIntegrity="false" required="true" prettyName="type" type="ENUMERATION" xpath="/employees/addr/addrs/type" uniqueId="TYPE_1">
                <value>work</value>
                <value>away</value>
                <value>home</value>
                <value>unknown</value>
             </field>
             <field collectionId="ADDR" titleField="false" enforceIntegrity="false" required="false" prettyName="line" type="STRING" xpath="/employees/addr/addrs/address/line" uniqueId="LINE"/>
             <field collectionId="ADDR" titleField="false" enforceIntegrity="false" required="false" prettyName="zip" type="STRING" xpath="/employees/addr/addrs/address/zip" uniqueId="ZIP"/>
          </layout>
          <matchid>1d969a54-49e5-4f75-974a-85869280873d</matchid>
          <matchconfig>
             <round>
                <matchrule xsi:type="GroupingRule" operator="AND" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                   <nestedExpression xsi:type="ExpressionRule" operator="EQUALS">
                      <input xsi:type="UniqueIdRuleInput" type="INCOMING" uniqueId="UQKEY"/>
                      <input xsi:type="UniqueIdRuleInput" type="EXISTING" uniqueId="UQKEY"/>
                   </nestedExpression>
                </matchrule>
             </round>
          </matchconfig>
          <dataquality>
             <step stepType="CONNECTOR" callFrequency="ALWAYS" connectionId="resource:mdm_loqate" objectTypeId="Verify" operationType="UPDATE" serviceType="loqate" templateName="Verify Address" templateId="verify" name="Verify Address" id="4ab40d19-e306-4670-97cb-93d8a8d03ff8">
                <field value="85" type="INTEGER" id="threshold"/>
                <field value="3" type="INTEGER" id="matchLevelThreshold"/>
                <input uniqueId="ZIP" id="postalcode"/>
                <output uniqueId="ZIP" id="postalcode"/>
             </step>
          </dataquality>
       </universe>

  • 400 (Bad Request) The universeID parameter value contains only space characters. Sample response body:

    <error>
       <message>The given universe id is blank.</message>
    </error>

  • 404 (Not Found) universeID does not identify a universe under the authenticated account. Sample response body:

    <error>
       <message>A universe with id 'ac11cc59-c77a-4afe-8c92-ed86a7daabec' does not exist.</message>
       <message>Universe definition with id 'ac11cc59-c77a-4afe-8c92-ed86a7daabec' could not be loaded 
       from plugin component directory 'plugins/mdm/bundles/ac11cc59-c77a-4afe-8c92-ed86a7daabec'.</message>
    </error>

  • 401 (Invalid Credentials) JWT auth token is expired. Sample response body:

    <body>
    <h2>HTTP ERROR 401</h2>
    <p>Problem accessing /mdm/universes. Reason:
    <pre>Invalid credentials.</pre>
    </p></body>

  • 403 (You do not have permissions to access this resource) User does not have the required MDM privilege to perform the action. Applicable to JWT auth only. Sample response body:

    <error><message>You do not have permissions to access this resource.</message></error>
On this Page